home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / IDLIncludes / DigitalSignature.idl < prev    next >
Text File  |  1996-05-01  |  12KB  |  238 lines
  1. /*
  2.      File:        DigitalSignature.idl
  3.  
  4.      Contains:    Digital Signature Interfaces.
  5.  
  6.      Version:    Technology:    AOCE toolbox 1.02
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. */
  18. #ifndef __DIGITALSIGNATURE_IDL__
  19. #define __DIGITALSIGNATURE_IDL__
  20.  
  21. #include <somobj.idl>
  22. #include <somcls.idl>
  23.  
  24. #ifndef __TYPES_IDL__
  25. #include <Types.idl>
  26. #endif
  27. #ifndef __MEMORY_IDL__
  28. #include <Memory.idl>
  29. #endif
  30. #ifndef __FILES_IDL__
  31. #include <Files.idl>
  32. #endif
  33.  
  34. #ifdef __SOMIDL__
  35.  
  36. #if FOR_SYSTEM7_ONLY
  37. /* values of SIGNameAttributeType */
  38. typedef unsigned short            SIGNameAttributeType;
  39.  
  40. /*
  41. Certificate status codes returned in SIGCertInfo or SIGSignerInfo from
  42. either SIGGetCertInfo or SIGGetSignerInfo respectively. kSIGValid means that
  43. the certificate is currently valid. kSIGPending means the certificate is
  44. currently not valid - but will be.  kSIGExpired means the certificate has
  45. expired. A time is always associated with a SIGCertStatus.  In each case the
  46. time has a specific interpretation.  When the status is kSIGValid the time is
  47. when the certificate will expire. When the status is kSIGPending the time is
  48. when the certificate will become valid. When the status is kSIGExpired the time
  49. is when the certificate expired. In the SIGCertInfo structure, the startDate
  50. and endDate fields hold the appropriate date information.  In the SIGSignerInfo
  51. structure, this information is provided in the certSetStatusTime field. In the
  52. SIGSignerInfo struct, the status time is actually represented by the SIGSignatureStatus
  53. field which can contain any of the types below. NOTE: The only time you will get 
  54. a kSIGInvalid status is when it pertains to a SIGSignatureStatus field and only when
  55. you get a signature that was created after the certificates expiration date, something
  56. we are not allowing on the Mac but that may not be restricted on other platforms. Also, 
  57. it will not be possible to get a kSIGPending value for SIGSignatureStatus on the Mac but
  58. possibly allowed by other platforms.
  59. */
  60. /* Values for SIGCertStatus or SIGSignatureStatus */
  61. typedef unsigned short            SIGCertStatus;
  62.  
  63. typedef unsigned short            SIGSignatureStatus;
  64.  
  65. /* Gestalt selector code - returns toolbox version in low-order word */
  66. /* Number of bytes needed for a digest record when using SIGDigest */
  67. typedef OpaquePtr                SIGDigestData;                /* Substituted OpaquePtr for array of Byte of size 16 */
  68.  
  69. typedef OpaquePtr                SIGDigestDataPtr;            /* Substituted OpaquePtr for ``Byte*'' */
  70.  
  71. typedef SOMLargeStruct            SIGCertInfo;                /* Derived from a struct of 274 bytes in size */
  72.  
  73. typedef OpaquePtr                SIGCertInfoPtr;                /* Substituted OpaquePtr for ``SIGCertInfo*'' */
  74.  
  75. typedef SOMLargeStruct            SIGSignerInfo;                /* Derived from a struct of 14 bytes in size */
  76.  
  77. typedef OpaquePtr                SIGSignerInfoPtr;            /* Substituted OpaquePtr for ``SIGSignerInfo*'' */
  78.  
  79. typedef SOMLargeStruct            SIGNameAttributesInfo;        /* Derived from a struct of 262 bytes in size */
  80.  
  81. typedef OpaquePtr                SIGNameAttributesInfoPtr;    /* Substituted OpaquePtr for ``SIGNameAttributesInfo*'' */
  82.  
  83. typedef Ptr                        SIGContextPtr;
  84.  
  85. typedef Ptr                        SIGSignaturePtr;
  86.  
  87. /*
  88. Certificates are always in order. That is, the signers cert is always 0, the
  89. issuer of the signers cert is always 1 etc... to the number of certificates-1.
  90. You can use this constant for readability in your code.
  91. */
  92. /*
  93. Call back procedure supplied by developer, return false to cancel the current
  94. process.
  95. */
  96. typedef OpaquePtr SIGStatusProcPtr;
  97. typedef OpaquePtr SIGStatusUPP;
  98. /*
  99. Resource id's of standard signature icon suite, all sizes and colors are available.
  100. */
  101. /*
  102.  -------------------------------------------------------------- CONTEXT CALLS -------------------------------------------------------------- 
  103. To use the Digital Signature toolbox you will need a SIGContextPtr.  To create
  104. a SIGContextPtr you simply call SIGNewContext and it will create and initialize
  105. a context for you.  To free the memory occupied by the context and invalidate
  106. its internal data, call SIGDisposeContext. An initialized context has no notion
  107. of the type of operation it will be performing however, once you call
  108. SIGSignPrepare SIGVerifyPrepare, or SIGDigestPrepare, the contexts operation
  109. type is set and to switch  to another type of operation will require creating a
  110. new context. Be sure to pass the same context to corresponding toolbox calls
  111. (ie SIGSignPrepare, SIGProcessData, SIGSign)  in other words mixing lets say
  112. signing and verify calls with the same context is not allowed.
  113. */
  114. /*
  115.  -------------------------------------------------------------- SIGNING CALLS -------------------------------------------------------------- 
  116. Once you have created a SIGContextPtr, you create a signature by calling
  117. SIGSignPrepare once, followed by n calls to SIGProcessData, followed by one call
  118. toRcpt SIGSign. To create another signature on different data but for the same
  119. signer, don't dispose of the context and call SIGProcessData for the new data
  120. followed by a call SIGSign again. In this case the signer will not be prompted
  121. for their signer and password again as it was already provided.  Once you call
  122. SIGDisposeContext, all signer information will be cleared out of the context and
  123. the signer will be re-prompted.  The signer file FSSpecPtr should be set to nil
  124. if you want the toolbox to use the last signer by default or prompt for a signer
  125. if none exists.  The prompt parameter can be used to pass a string to be displayed
  126. in the dialog that prompts the user for their password.  If the substring "^1"
  127. (without the quotes) is in the prompt string, then the toolbox will replace it
  128. with the name of the signer from the signer selected by the user.  If an empty
  129. string is passed, the following default string will be sent to the toolbox
  130. "\pSigning as ^1.".  You can call any of the utility routines after SIGSignPrepare
  131. or SIGSign to get information about the signer or certs.
  132. */
  133. /*
  134.  -------------------------------------------------------------- VERIFYING CALLS -------------------------------------------------------------- 
  135. Once you have created a SIGContextPtr, you verify a signature by calling
  136. SIGVerifyPrepare  once, followed by n calls to SIGProcessData, followed by one
  137. call to SIGVerify. Check the return code from SIGVerify to see if the signature
  138. verified or not (noErr is returned on  success otherwise the appropriate error
  139. code).  Upon successfull verification, you can call any of the utility routines
  140. toRcpt find out who signed the data.
  141. */
  142. /*
  143.  ------------------------------------------------------------ DIGESTING CALLS ------------------------------------------------------------ 
  144. Once you have created a SIGContextPtr, you create a digest by calling
  145. SIGDigestPrepare once, followed by n calls to SIGProcessData, followed by one
  146. call to SIGDigest.  You can dispose of the context after SIGDigest as the
  147. SIGDigestData does not reference back into it.  SIGDigest returns the digest in
  148. digest.
  149. */
  150. /*
  151.  ------------------------------------------------------------ PROCESSING DATA ------------------------------------------------------------ 
  152. To process data during a digest, sign, or verify operation call SIGProcessData
  153. as many times as necessary and with any sized blocks of data.  The data needs to
  154. be processed in the same order during corresponding sign and verify operations
  155. but does not need to be processed in the same sized chunks (i.e., the toolbox
  156. just sees it as a continuous bit stream).
  157. */
  158. /*
  159.  -------------------------------------------------------------- UTILITY CALLS -------------------------------------------------------------- 
  160. Given a context that has successfully performed a verification SIGShowSigner
  161. will  display a modal dialog with the entire distinguished name of the person
  162. who signed the data. the prompt (if supplied) will appear at the top of the
  163. dialog.  If no prompt is specified, the default prompt "\pVerification
  164. Successfull." will appear.
  165.  
  166. Given a context that has been populated by calling SIGSignPrepare, SIGSign or a
  167. successful SIGVerify, you can make the remaining utility calls:
  168.  
  169. SIGGetSignerInfo will return the SignerInfo record.  The certCount can be used
  170. toRcpt index into the certificate set when calling SIGGetCertInfo,
  171. SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes. The signingTime is
  172. only defined if the call is made after SIGSign  or SIGVerify. The certSetStatus
  173. will tell you the best status of the entire certificate set while
  174. certSetStatusTime will correspond to the time associated with that status (see
  175. definitions above).
  176.  
  177. SIGGetCertInfo will return the SIGCertInfo record when given a valid index into
  178. the cert set in  certIndex.  Note: The cert at index kSIGSignerCertIndex is
  179. always the signers certificate.  The  serial number, start date and end date
  180. are there should you wish to display that info.  The  certAttributeCount and
  181. issuerAttributeCount provide the number of parts in the name of that certificate
  182. or that certificates issuer respectively.  You use these numbers to index into
  183. either SIGGetCertNameAttributes or SIGGetCertIssuerNameAttributes to retrieve
  184. the name. The certStatus will tell you the status of the certificate while
  185. certStatusTime will correspond to the time associated with that status (see
  186. definitions above).
  187.  
  188. SIGGetCertNameAttributes and SIGGetCertIssuerNameAttributes return name parts
  189. of the certificate at  certIndex and attributeIndex.  The newLevel return value
  190. tells you wether the name attribute returned is at the same level in the name
  191. hierarchy as the previous attribute.  The type return value tells you  the type
  192. of attribute returned. nameAttribute is the actual string containing the name
  193. attribute.   So, if you wanted to display the entire distinguished name of the
  194. person who's signature was just validated you could do something like this;
  195.  
  196.     (...... variable declarations and verification code would preceed this sample ......)
  197.  
  198.     error = SIGGetCertInfo(verifyContext, kSIGSignerCertIndex, &certInfo);
  199.     HandleErr(error);
  200.  
  201.     for (i = 0; i <= certInfo.certAttributeCount-1; i++)
  202.         {
  203.         error = SIGGetCertNameAttributes(
  204.             verifyContext, kSIGSignerCertIndex, i, &newLevel, &type, theAttribute);
  205.         HandleErr(error);
  206.         DisplayNamePart(theAttribute, type, newLevel);
  207.         }
  208. */
  209. /*
  210.  ------------------------------------------------------ FILE SIGN & VERIFY CALLS ---------------------------------------------------- 
  211. These calls allow you to detect the presence of a standard signtaure in a file as 
  212. well as sign and verify files in a standard way.  An example of this is the Finder, 
  213. which uses these calls to allow the user to "drop sign" a file.
  214.  
  215. To detect if a file is signed in the standard way, pass the FSSpec of the file to SIGFileIsSigned.
  216. A result of noErr means the file is in fact signed, otherwise, a kSIGNoSignature error will
  217. be returned.
  218.  
  219. Once you have created a SIGContextPtr, you can make calls to either sign or verify a file in
  220. a standard way: 
  221.  
  222. To sign a file, call SIGSignPrepare followed by 'n' number of calls to SIGSignFile,
  223. passing it the file spec for each file you wish to sign in turn.  You supply the context, the signature 
  224. size that was returned from SIGSignPrepare and an optional call back proc.  The call will take care of all
  225. the processing of data and affixing the signature to the file. If a signature already exists in the file, 
  226. it is replaced with the newly created signature.
  227.  
  228. To verify a file that was signed using SIGSignFile, call SIGVerifyFile passing it a new context and 
  229. the file spec.  Once this call has completed, if the verification is successfull, you can pass the context 
  230. to SIGShowSigner to display the name of the person who signed the file.
  231. */
  232. #endif
  233.  
  234. #endif /* __SOMIDL__ */
  235.  
  236. #endif /* __DIGITALSIGNATURE_IDL__ */
  237.  
  238.